contrib/database/sql: Close DB Stats goroutine on db.Close() #3025
+63
−17
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
apm:ecosystem
Datadog ReportBranch report: ❌ 1 Failed (0 Known Flaky), 5014 Passed, 71 Skipped, 2m 44.91s Total Time ❌ Failed Tests (1)
|
mtoffl01
force-pushed
the
mtoff/contrib-routines
branch
from
0692055 to
37b52f9
Compare
darccio
requested changes
Jan 17, 2025
| }) | ||
| } | ||
|
|
||
| func GetStopChan() chan struct{} { |
There was a problem hiding this comment.
Suggested change
| func GetStopChan() chan struct{} { | |
| func StopChan() chan struct{} { |
This would be a better name.
| mu sync.Mutex | ||
| ) | ||
|
|
||
| func InitStopChan() { |
There was a problem hiding this comment.
Suggested change
| func InitStopChan() { | |
| func Init() { |
Just in case this package evolves and needs to initialize more things beyond the stop chan.
darccio
approved these changes
Jan 17, 2025
Datadog ReportBranch report: ✅ 0 Failed, 5208 Passed, 72 Skipped, 2m 45.92s Total Time |
mtoffl01
changed the title
darccio
approved these changes
Jan 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Introduces a stop condition for the
pollDBStatsgoroutine when db.Close() has been invoked by the user.Motivation
Protecting against runaway goroutines.
Details
Background
To register a sql driver for instrumentation, a user must call sqltrace.Open, which passes our
tracedConnectorinto the OpenDB function. ThistracedConnectoris used as thec driver.Connectorargument to database/sql's OpenDB function, which is set on the DB.connector field.When
db.Close()is called by the user, the database/sql code checks whether theDB.connectorsatisfies theio.Closerinterface and, if so, callsconnector.Close().Therefore, to identify when a user has called
db.Close(), we can implement (and control) atracedConnector.Close()method.Implementation
A new
tracedConnector.dbClosechannel is closed whentracedConnector.Close()is invoked. ThepollDBStatsgoroutine returns (stops) when there is activity on thedbClosechannel.In this way, we've tied the
pollDBStatsgoroutine to the lifecycle of the db.Next Steps
Once this approach is approved, we will do the same thing for the contrib/jackc/pgx
pollPoolStatsgoroutine.Reviewer's Checklist
v2-devbranch and reviewed by @DataDog/apm-go.Unsure? Have a question? Request a review!